home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / catn / gets.n < prev    next >
Text File  |  1994-09-20  |  2KB  |  67 lines
  1.  
  2.  
  3.  
  4. gets(n)               Tcl Built-In Commands
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      gets - Read a line from a file
  12.  
  13. SYNOPSIS
  14.      gets _f_i_l_e_I_d ?_v_a_r_N_a_m_e?
  15. _________________________________________________________________
  16.  
  17.  
  18. DESCRIPTION
  19.      This command reads the next line  from  the  file  given  by
  20.      _f_i_l_e_I_d  and  discards the terminating newline character.  If
  21.      _v_a_r_N_a_m_e is specified then the line is placed in the variable
  22.      by  that  name and the return value is a count of the number
  23.      of characters read (not including the newline).  If the  end
  24.      of the file is reached before reading any characters then -1
  25.      is returned and _v_a_r_N_a_m_e is set to an empty string.  If  _v_a_r_-
  26.      _N_a_m_e is not specified then the return value will be the line
  27.      (minus the newline character) or an empty string if the  end
  28.      of  the  file  is reached before reading any characters.  An
  29.      empty string will also be returned if  a  line  contains  no
  30.      characters except the newline, so eof may have to be used to
  31.      determine what really happened.  If the  last  character  in
  32.      the  file is not a newline character then gets behaves as if
  33.      there were an additional newline character at the end of the
  34.      file.   _F_i_l_e_I_d must be stdin or the return value from a pre-
  35.      vious call to open; it must refer to a file that was  opened
  36.      for reading.  Any existing end-of-file or error condition on  |
  37.      the file is cleared at the beginning of the gets command.
  38.  
  39.  
  40. KEYWORDS
  41.      file, line, read
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63. Tcl                                                             1
  64.  
  65.  
  66.  
  67.